v0.19.2

Compare Source

Patch Changes

• #​131 14f4d8d Thanks @​DaniFoldi! - Adds astro as a peer dependency to prevent potential build errors in monorepos with hoisting disabled.

v0.19.1

Compare Source

Patch Changes

• #​127 2c0e83d Thanks @​HiDeoo! - Fixes validation issues with links containing query strings when using the Astro trailingSlash option.

v0.19.0

Compare Source

Minor Changes

• #​123 e9cc59d Thanks @​HiDeoo! - Adds validation of hero action links in frontmatter.

• #​123 e9cc59d Thanks @​HiDeoo! - Adds validation of previous and next page links in frontmatter.

v0.18.1

Compare Source

Patch Changes

• #​121 242bc28 Thanks @​HiDeoo! - Setups trusted publishing using OpenID Connect (OIDC) authentication — no code changes.

v0.18.0

Compare Source

Minor Changes

• #​118 efef54a Thanks @​HiDeoo! - Adds hyperlinks (OSC 8) support to validation terminal output.

  In supported terminals, error slugs can be conveniently used (e.g. with Ctrl+Click, Opt+Click, Cmd+Click, or a context menu) to open the corresponding file using the default associated application.

v0.17.2

Compare Source

Patch Changes

• #​115 b042c61 Thanks @​trueberryless! - Fixes validation issue for links to Starlight page's title anchor, e.g. /getting-started/#_top.

v0.17.1

Compare Source

Patch Changes

• #​113 3e0a88c Thanks @​HiDeoo! - Prevents plugin remark plugin from running on Markdown and MDX content when using the Astro renderMarkdown() content loader API.

v0.17.0

Compare Source

Minor Changes

• #​108 82f8ec5 Thanks @​HiDeoo! - Adds support for excluding links from validation using a function.

  When using the function syntax, the function should return true for any link that should be excluded from validation or false otherwise. The function will be called for each link to validate and will receive an object containing various properties to help determine whether to exclude the link or not.

  Check out the exclude configuration option documentation for more details and examples.

v0.16.0

Compare Source

Minor Changes

• #​104 cbeaa0f Thanks @​HiDeoo! - Ignores query strings when checking for excluded links.

  Previously, to exclude links with query strings, you may have needed to rely on fairly loose glob patterns, e.g. /playground/** to exclude /playground/, /playground/?id=foo and /playground/?id=bar. With this change, excluding /playground/ will ignore all query strings, so /playground/, /playground/?id=foo and /playground/?id=bar will all be excluded.

v0.15.1

Compare Source

Patch Changes

• #​102 88e66a8 Thanks @​HiDeoo! - Fixes a regression with version 0.15.0 where the errorOnLocalLinks option was not being applied correctly.

v0.15.0

Compare Source

Minor Changes

• #​93 6d7174b Thanks @​HiDeoo! - ⚠️ BREAKING CHANGE: The minimum supported version of Starlight is now version 0.32.0.

  Please use the @astrojs/upgrade command to upgrade your project:

  npx @​astrojs/upgrade

• #​100 b238cb7 Thanks @​HiDeoo! - Adds a new sameSitePolicy option to configure how external links pointing to the same origin as the one configured in the Astro site option should be handled.

  The current default behavior to ignore all external links remains unchanged. This new option allows to error on such links so they can be rewritten without the origin or to validate them as if they were internal links.

• #​100 b238cb7 Thanks @​HiDeoo! - Adds a new components option to define additional components and their props to validate as links on top of the built-in <LinkButton> and <LinkCard> Starlight components.

Patch Changes

• #​99 56ea78c Thanks @​HiDeoo! - Fixes validation issue with the Astro base option and the errorOnFallbackPages plugin option set to false in a multilingual project.

v0.14.3

Compare Source

Patch Changes

• #​91 1ef31b8 Thanks @​DaniFoldi! - Moves mdast-util-mdx-jsx package to non-dev dependencies to prevent issues in monorepos with hoisting disabled.

v0.14.2

Compare Source

Patch Changes

• #​85 57fdb1b Thanks @​HiDeoo! - Improves error message for invalid links to custom pages.

v0.14.1

Compare Source

Patch Changes

• #​82 b3cbee8 Thanks @​HiDeoo! - Fixes regresion introduced in version 0.14.0 of the plugin regarding validation of links to pages with custom IDs/slugs.

  Note that you must use at least Astro version 5.1.1 to benefit from this fix.

• #​80 876cb50 Thanks @​lukekarrys! - Fixes validation issues for pages ending in index, e.g. module_index.

v0.14.0

Compare Source

Minor Changes

• #​77 486a379 Thanks @​HiDeoo! - Adds support for Astro v5, drops support for Astro v4.

  ⚠️ BREAKING CHANGE: The minimum supported version of Starlight is now 0.30.0.

  Please follow the upgrade guide to update your project.

  When using the plugin with the Content Layer API, the plugin will now automatically invalidate the content layer cache so that all links can be properly validated. To avoid unnecessary cache invalidation, it is recommended to conditionally use the plugin only when necessary. Check out the new “Conditional Validation” guide for more information.

  ⚠️ BREAKING CHANGE: Due to a regression in Astro v5, links to pages with custom IDs/slugs can no longer be validated and will be flagged as invalid. If you rely on this feature, please stay on a previous version of Starlight and Astro in the meantime.

v0.13.4

Compare Source

   🐞 Bug Fixes

• Fixes a validation issue with Markdown headings including trailing markup  -  by @​jorenbroekema and @​HiDeoo (009be)

    View changes on GitHub

v0.13.3

Compare Source

   🚀 Features

• Improves messages for errors related to the Astro trailingSlash option to indicate if a link is missing a trailing slash or if a link has a trailing slash when it should not  -  by @​HiDeoo (a8776)

    View changes on GitHub

v0.13.2

Compare Source

   🐞 Bug Fixes

• Fixes a potential type-checking issue in some Starlight projects  -  by @​HiDeoo (1e33b)

    View changes on GitHub

v0.13.1

Compare Source

   🐞 Bug Fixes

• Refactors some internal types to prevent type issues with future Starlight versions  -  by @​HiDeoo (11518)

    View changes on GitHub

v0.13.0

Compare Source

   🚨 Breaking Changes

• Adds errors for local links, e.g. URLs with a hostname of localhost or 127.0.0.1  -  by @​HiDeoo (80636)

  In previous versions, such links were silently ignored. They are now considered as invalid links as they are usually used for development purposes and should not be present in production.
  If you want to preserve the previous behaviour, you can set the errorOnLocalLinks option to false in your astro.config.mjs file:

  export default defineConfig({
    integrations: [
      starlight({
        plugins: [
          starlightLinksValidator({
            errorOnLocalLinks: false,
          }),
        ],
      }),
    ],
  });

    View changes on GitHub

v0.12.4

Compare Source

   🐞 Bug Fixes

• Ignores links in draft pages  -  by @​HiDeoo (da925)

    View changes on GitHub

v0.12.3

Compare Source

   🐞 Bug Fixes

• Fixes validation issues with links containing query strings  -  by @​HiDeoo (47b38)

    View changes on GitHub

v0.12.2

Compare Source

   🐞 Bug Fixes

• Fixes validation issue with the Astro base option and a custom slug  -  by @​HiDeoo (fe3d2)

    View changes on GitHub

v0.12.1

Compare Source

   🐞 Bug Fixes

• Fixes a potential type-checking issue in user projects  -  by @​HiDeoo (09012)

    View changes on GitHub

v0.12.0

Compare Source

   🚀 Features

• Adds a new errorOnInvalidHashes option defaulting to true to disable hash validation  -  by @​HiDeoo (32a92)
  The default validation behavior remains unchanged.

    View changes on GitHub

v0.11.0

Compare Source

   🚀 Features

• Adds support for validating internal links in <LinkCard> and <LinkButton> components  -  by @​HiDeoo (00599)

    View changes on GitHub